juce/source/extras/the jucer/src/model/paintelements/jucer_PaintElement.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCER_PAINTELEMENT_JUCEHEADER__
  27 #define __JUCER_PAINTELEMENT_JUCEHEADER__
  28
  29 #include "../jucer_GeneratedCode.h"
  30 class FillType;
  31 class PaintRoutine;
  32 class JucerDocument;
  33 class ElementSiblingComponent;
  34
  35
  36 //==============================================================================
  37 /**
  38     Base class for objects that can be used in a PaintRoutine.
  39
  40 */
  41 class PaintElement  : public Component,
  42                       public ChangeListener,
  43                       public ComponentBoundsConstrainer
  44 {
  45 public:
  46     //==============================================================================
  47     PaintElement (PaintRoutine* owner, const String& typeName);
  48     virtual ~PaintElement();
  49
  50     //==============================================================================
  51     virtual void setInitialBounds (int parentWidth, int parentHeight);
  52
  53     virtual const Rectangle<int> getCurrentBounds (const Rectangle<int>& activeArea) const;
  54     virtual void setCurrentBounds (const Rectangle<int>& newBounds, const Rectangle<int>& activeArea, const bool undoable);
  55
  56     const RelativePositionedRectangle& getPosition() const;
  57     void setPosition (const RelativePositionedRectangle& newPosition, const bool undoable);
  58
  59     void updateBounds (const Rectangle<int>& activeArea);
  60
  61     const String& getTypeName() const throw()                   { return typeName; }
  62     PaintRoutine* getOwner() const throw()                      { return owner; }
  63
  64     //==============================================================================
  65     virtual void draw (Graphics& g,
  66                        const ComponentLayout* layout,
  67                        const Rectangle<int>& parentArea) = 0;
  68
  69     virtual void drawExtraEditorGraphics (Graphics& g, const Rectangle<int>& relativeTo);
  70
  71     virtual void getEditableProperties (Array <PropertyComponent*>& properties);
  72
  73     virtual void showPopupMenu();
  74
  75     //==============================================================================
  76     virtual XmlElement* createXml() const = 0;
  77     virtual bool loadFromXml (const XmlElement& xml) = 0;
  78
  79     //==============================================================================
  80     virtual void fillInGeneratedCode (GeneratedCode& code, String& paintMethodCode) = 0;
  81
  82     JucerDocument* getDocument() const;
  83
  84     virtual void changed();
  85     bool perform (UndoableAction* action, const String& actionName);
  86
  87     //==============================================================================
  88     void paint (Graphics& g);
  89     void resized();
  90     void mouseDown (const MouseEvent& e);
  91     void mouseDrag (const MouseEvent& e);
  92     void mouseUp (const MouseEvent& e);
  93     void changeListenerCallback (ChangeBroadcaster*);
  94     void parentHierarchyChanged();
  95
  96     int borderThickness;
  97
  98 protected:
  99     PaintRoutine* const owner;
 100     RelativePositionedRectangle position;
 101
 102     void resizeStart();
 103     void resizeEnd();
 104     void checkBounds (Rectangle<int>& bounds,
 105                       const Rectangle<int>& previousBounds,
 106                       const Rectangle<int>& limits,
 107                       bool isStretchingTop,
 108                       bool isStretchingLeft,
 109                       bool isStretchingBottom,
 110                       bool isStretchingRight);
 111
 112     void applyBoundsToComponent (Component* component, const Rectangle<int>& bounds);
 113
 114     const Rectangle<int> getCurrentAbsoluteBounds() const;
 115     void getCurrentAbsoluteBoundsDouble (double& x, double& y, double& w, double& h) const;
 116
 117     virtual void selectionChanged (const bool isSelected);
 118
 119     virtual void createSiblingComponents();
 120
 121     void siblingComponentsChanged();
 122
 123     OwnedArray <ElementSiblingComponent> siblingComponents;
 124
 125     void updateSiblingComps();
 126
 127 private:
 128     ResizableBorderComponent* border;
 129     String typeName;
 130     bool selected, dragging, mouseDownSelectStatus;
 131     double originalAspectRatio;
 132     ChangeBroadcaster selfChangeListenerList;
 133 };
 134
 135
 136 #endif   // __JUCER_PAINTELEMENT_JUCEHEADER__